Node / meshtastic / Meshtastic-Android / files / core / ble / src / commonMain / kotlin / org / meshtastic / core / ble / BleLoggingConfig.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2026 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tff7b72package T7ee787org.meshtastic.core.ble

Tff7b72import T7ee787com.juul.kable.logs.Logging

T8b949e/**

* Verbosity for Kable's internal BLE logging. Wraps [Logging.Level] so callers and the Koin DI graph don't leak Kable

* types into modules that don't directly depend on Kable.

*/

Tff7b72enum Tff7b72class T56d364BleLogLevel Tb4b4b4{

T8b949e/** Only failures (lowest noise; default in release builds). */

Te6edf3WarningsTb4b4b4,

T8b949e/** [Warnings] plus connect / disconnect / subscribe / GATT operation events. */

Te6edf3EventsTb4b4b4,

T8b949e/** [Events] plus a hex dump of every read/write/notify payload. Very noisy. */

Te6edf3DataTb4b4b4,

Tb4b4b4}

T8b949e/**

* Format for Kable's internal BLE log entries.

*

* [Compact] keeps each entry on a single line — strongly preferred for `adb logcat`, grep, and bug reports. [Multiline]

* pretty-prints across several lines, which is harder to read in tooling.

*/

Tff7b72enum Tff7b72class T56d364BleLogFormat Tb4b4b4{

Te6edf3CompactTb4b4b4,

Te6edf3MultilineTb4b4b4,

Tb4b4b4}

T8b949e/**

* Verbosity and formatting controls for Kable's internal BLE logging.

*

* @see BleLogLevel for the verbosity scale.

* @see BleLogFormat for the layout choices.

*/

Tff7b72data Tff7b72class T56d364BleLoggingConfigTb4b4b4(Tff7b72val Te6edf3levelTb4b4b4: Te6edf3BleLogLevelTb4b4b4, Tff7b72val Te6edf3formatTb4b4b4: Te6edf3BleLogFormat Tff7b72= Te6edf3BleLogFormatTb4b4b4.Te6edf3CompactTb4b4b4) Tb4b4b4{

Tff7b72companion Tff7b72object Tb4b4b4{

T8b949e/** Quiet defaults suitable for release builds — only warnings, single-line. */

Tff7b72val Te6edf3ReleaseTb4b4b4: Te6edf3BleLoggingConfig Tff7b72= Te6edf3BleLoggingConfigTb4b4b4(Te6edf3level Tff7b72= Te6edf3BleLogLevelTb4b4b4.Te6edf3WarningsTb4b4b4)

T8b949e/** Verbose defaults suitable for debug builds — every BLE event, single-line. */

Tff7b72val Te6edf3DebugTb4b4b4: Te6edf3BleLoggingConfig Tff7b72= Te6edf3BleLoggingConfigTb4b4b4(Te6edf3level Tff7b72= Te6edf3BleLogLevelTb4b4b4.Te6edf3EventsTb4b4b4)

Tb4b4b4}

Tb4b4b4}

Tff7b72internal Tff7b72fun Te6edf3BleLogLevelTb4b4b4.Td2a8fftoKableTb4b4b4(Tb4b4b4)Tb4b4b4: Te6edf3LoggingTb4b4b4.Te6edf3Level Tff7b72= Tff7b72when Tb4b4b4(Tff7b72thisTb4b4b4) Tb4b4b4{

Te6edf3BleLogLevelTb4b4b4.Te6edf3Warnings Tff7b72-Tff7b72> Te6edf3LoggingTb4b4b4.Te6edf3LevelTb4b4b4.Te6edf3Warnings

Te6edf3BleLogLevelTb4b4b4.Te6edf3Events Tff7b72-Tff7b72> Te6edf3LoggingTb4b4b4.Te6edf3LevelTb4b4b4.Te6edf3Events

Te6edf3BleLogLevelTb4b4b4.Te6edf3Data Tff7b72-Tff7b72> Te6edf3LoggingTb4b4b4.Te6edf3LevelTb4b4b4.Te6edf3Data

Tb4b4b4}

Tff7b72internal Tff7b72fun Te6edf3BleLogFormatTb4b4b4.Td2a8fftoKableTb4b4b4(Tb4b4b4)Tb4b4b4: Te6edf3LoggingTb4b4b4.Te6edf3Format Tff7b72= Tff7b72when Tb4b4b4(Tff7b72thisTb4b4b4) Tb4b4b4{

Te6edf3BleLogFormatTb4b4b4.Te6edf3Compact Tff7b72-Tff7b72> Te6edf3LoggingTb4b4b4.Te6edf3FormatTb4b4b4.Te6edf3Compact

Te6edf3BleLogFormatTb4b4b4.Te6edf3Multiline Tff7b72-Tff7b72> Te6edf3LoggingTb4b4b4.Te6edf3FormatTb4b4b4.Te6edf3Multiline

Tb4b4b4}

T8b949e/** Applies this [BleLoggingConfig] to a Kable `logging { }` block, routing through [KermitLogEngine]. */

Tff7b72internal Tff7b72fun Te6edf3LoggingTb4b4b4.Td2a8ffapplyConfigTb4b4b4(Te6edf3configTb4b4b4: Te6edf3BleLoggingConfigTb4b4b4, Te6edf3identifierTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4) Tb4b4b4{

Te6edf3engine Tff7b72= Te6edf3KermitLogEngine

Te6edf3level Tff7b72= Te6edf3configTb4b4b4.Te6edf3levelTb4b4b4.Te6edf3toKableTb4b4b4(Tb4b4b4)

Te6edf3format Tff7b72= Te6edf3configTb4b4b4.Te6edf3formatTb4b4b4.Te6edf3toKableTb4b4b4(Tb4b4b4)

Tff7b72if Tb4b4b4(Te6edf3identifier Tff7b72!Tff7b72= Tff7b72nullTb4b4b4) Tb4b4b4{

Tff7b72thisTb4b4b4.Te6edf3identifier Tff7b72= Te6edf3identifier

Tb4b4b4}

Tb4b4b4}